home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / cardex.arc / CARDEX.DOC < prev    next >
Encoding:
Text File  |  1986-05-26  |  16.3 KB  |  291 lines
  1. -------------------------------------------------------------------------------
  2.  
  3.                                   C A R D E X
  4.  
  5. -------------------------------------------------------------------------------
  6.  
  7.    This is the documentation file for CARDEX by Carson Information Services.
  8.  
  9. -------------------------------------------------------------------------------
  10.  
  11.        Written by Mark L.Carson, 821-A Puunani Place, Honolulu, HI 96817
  12.  
  13.                       Copyright 1986 - Mark L. Carson
  14.                       Copyright 1985 - Borland International
  15.                       Copyright 1985 - Blaise Computing
  16.  
  17. -------------------------------------------------------------------------------
  18.  
  19.                              ++================++
  20.                              ||                ||
  21.                              ||  N O T I C E   ||
  22.                              ||                ||
  23.                              ++================++
  24.  
  25. CARDEX by Carson Information Services is a copyrighted work and is NOT a public
  26. domain program. No modification or alteration to CARDEX is authorized. Any such
  27. modification or alteration constitutes illegal and unlicensed use. The source
  28. code is not intended nor available for public distribution.
  29.  
  30. If you did not purchase the copy of CARDEX you are using, and find the program
  31. useful, you are encouraged to send what you feel the program's worth to you is
  32. to Carson Information Services. If you would like to purchase a customized or
  33. modified version of CARDEX, please write to Carson Information Services with
  34. your request.  THANK YOU.
  35.                                           - Mark Carson
  36.  
  37. -------------------------------------------------------------------------------
  38.  
  39. CARDEX files :  CARDEX.COM  - The executable file
  40.                 CARDEX.CFG  - The configuration file (optional) that tells the
  41.                               computer if you have a color/graphics monitor ,
  42.                               your local area code, long distance access number,
  43.                               if form feeds are sent to the printer, and the
  44.                               default data file.
  45.                 CARDEX.DAT  - The file generated by CARDEX.COM for data storage
  46.                               if no data file is specified in CARDEX.CFG or by
  47.                               the user at run time.
  48.                 CARDEX.DOC  - This file, the documentation file that explains
  49.                               the functions of CARDEX
  50.  
  51. UTILITY files : CX2TEXT.COM - Creates an ASCII file from a CARDEX data file
  52.                 TEXT2CX.COM - Creates a CARDEX data file from an ASCII file
  53.                 CXMERGE.COM - Merges two CARDEX data files
  54.                 ZIPSORT.COM - Creates a zip code filtered CARDEX data file
  55.  
  56. -------------------------------------------------------------------------------
  57.  
  58.     VERSION : 1.2 P/N     - Personal use, non-memory-resident version.
  59.                             Cards have last and first name fields.
  60.                             Executes as a stand alone COM file.
  61.  
  62. -------------------------------------------------------------------------------
  63.  
  64.                                    OVERVIEW
  65.  
  66. CARDEX creates an rotary index card file on IBM PC computers and compatibles.
  67. It is the equivelent of a ROLODEX (tm) for storing addresses, phone numbers,
  68. and misc. information of persons or companies. CARDEX is a visual facsimile
  69. of a rotaty index card file, with the added feature that the names and phone
  70. numbers of the three preceeding entries and three following entries are
  71. visible along with the full information on the current card.
  72.  
  73. All 10 function keys are utilized. The opening screen lists their functions.
  74. The CARDEX screen summarizes the functions of the 6 most frequently used keys
  75. in the lower right portion of the screen, with the PRINT key selecting a
  76. sub-menu of the 4 print commands. 3 of these print commands are directly
  77. available without having to select the PRINT sub-menu first.
  78. The up and down cusor keys, the PgUp and PgDn and Home keys are also active
  79. and allow the user to "spin" the CARDEX file (select preceeding/following
  80. cards). The HOME key advances the CARDEX to the first card. The End key ends
  81. use of the current data file and prompts the user for a new data file. The "M"
  82. and "T" keys are used to transfer (copy) data from one data file to another.
  83. The Esc key exits the CARDEX program, saving the data to disk file if changes
  84. have been made during the current CARDEX session.
  85.  
  86. CARDEX reads data from an external file (floppy or hard disk) and stores
  87. all the data from the file in memory. The data is accessed via pointers.
  88. Upon exit, the data in memory is read back onto the disk (if the data file was
  89. changed). If the data file to be read from (specified from the opening screen)
  90. does not exist, CARDEX initializes with the author's name and address as the
  91. first card. If additional entries are made, the file name specified is created
  92. and written to. After entering a second card, the user may delete the author's
  93. card from his data file, but is encouraged to maintain this entry. Should the
  94. user need to contact the author, this information can always be accessed by
  95. specifying a data file that does not currently exist when promted in the
  96. opening menu or when selecting a new data file using the END key.
  97.  
  98. Besides presenting information on the screen, CARDEX can print the contents of
  99. a single card, or the contents of all cards, and can print an address label of
  100. a single card, or of all cards. Mailing lists can be kept on CARDEX and
  101. address labels printed with a single keystroke. Labels are printed using 3
  102. lines per label for the name and address with 3 additional lines spacing to
  103. the next label. Suggested set up is using 6 lines to the inch printer advance
  104. and 1 inch by 3.5 inch or wider labels. Pressing the Esc key aborts the
  105. printing of a list of card contents or address labels.
  106.  
  107.               --------------------------------------------------
  108.  
  109.                  IF YOU HAVE A MODEM AND SIDKICK (tm)
  110.  
  111. CARDEX also is compatible with the telephone dialer function of Borland Intl's
  112. SIDEKICK (tm). CARDEX writes the telephone number of the current card in the
  113. upper left hand corner of the screen, (invisibly, to the user with most video
  114. display adaptors, (but always visible to SIDEKICK), so the dialer in SIDEKICK
  115. will detect the telephone number of the current card rather than the first user
  116. visible number (which is the card entry 3 past (above) of the current card).
  117. CARDEX, by use of the default area code, knows when to write the long distance
  118. access code and the area code ahead of the telephone number for long distance
  119. dialing. Long distance dialing within the default area code is not directly
  120. supported. For long distance within the user's area code, it is recommended the
  121. user enter the long distance access code, ("1", etc.), followed by the phone
  122. number in the additional information lines of the card entry (the last five
  123. lines of the card). Then SIDEKICK's "captured" phone number can be advanced
  124. using the right cursor key until this number is highlighted, then dialing can
  125. be performed. Long distance services requiring pauses are supported by SIDEKICK
  126. by using an "@" to pause the diaing. The CONFIGURATION/SET-UP mode prompts for
  127. your long distance access code. Your local access number, followed by a pause
  128. ("@") and your authorization code will allow access to long distance services.
  129. If no particular long distance service is desired, use the default access value
  130. of "1-".
  131.  
  132. -------------------------------------------------------------------------------
  133.  
  134.                        FUNCTION AND CUSOR KEY COMMANDS
  135.  
  136.         F1 : Configure the CARDEX system for Monitor, Area Code, Long Distance
  137.              Access Number, Printer Form Feeds, & Default Data File Name.
  138.         F2 : Add a new card to the CARDEX. (Automatically inserted in order)
  139.         F3 : Prints the name and address of the current card in label format.
  140.         F4 : GOTO - The user enters a name to match, CARDEX advances to it.
  141.         F5 : Prints address labels for all cards in the CARDEX.
  142.         F6 : Edits the information on the current card.
  143.         F7 : Prints out all of the information in the current data file.
  144.         F8 : Deletes the current card from the CARDEX.
  145.         F9 : Print Menu / Prints out the information of the current card.
  146.        F10 : Manually saves the data to disk.
  147.              (Automatic save is done upon exit if the data file was changed)
  148.  
  149.   Up arrow : Selects the card above the current card.
  150. Down arrow : Selects the card below the current card.
  151.       PgUp : Advances the CARDEX ahead 4 cards.
  152.       PgDn : Advances the CARDEX back 4 cards.
  153.       Home : Selects first card in the current data file.
  154.        End : Ends use of the current data file, and asks for a new data file.
  155.  
  156.          M : Marks the currently displayed card for subsequent copying to
  157.              another CARDEX data file.
  158.          T : Transfers (copies) the data from the marked card to the current
  159.              CARDEX data file. (this only works for transferring between files)
  160.  
  161.        Esc : Exit program. Also aborts printing of lists and escapes from
  162.              selected functions.
  163.  
  164. -------------------------------------------------------------------------------
  165.  
  166.                          RECORD AND FILE INFORMATION
  167.  
  168.  
  169. All data is of type character string, however the record structure used does
  170. not store data as a text file, so data is not readily readable without CARDEX.
  171. CARDEX defaults using CARDEX.DAT for an initial data file but additional data
  172. files can be user named. The user may want to have a number of different data
  173. files, (friends, business contacts, Christmas card list, mailing lists, etc.).
  174. Any legal file name may be used. Personally, I use my initials for my personal
  175. data file, and the suffix ".CX" to indicate a CARDEX data file. The reason
  176. CARDEX uses "CARDEX.DAT" for internal default, is so a first time or
  177. ocassional user can correlate the data file with the program, and so using the
  178. DOS copy command "COPY CARDEX.*" will copy the data file along with the CARDEX
  179. program file, the configuration file, and this documentation file.
  180.  
  181. Record size is 420 bytes on disk and 432 bytes in RAM. (12 bytes used by the
  182. forward and backward pointers.)
  183.  
  184. CARDEX data files can be copied to ASCII text files using the external
  185. utility program CX2TEXT.COM, the source CARDEX data file and target ASCII file
  186. can be pased to CX2TEXT.COM as command line parameters 1 and 2 respectively.
  187. The CARDEX utility TEXT2CX.COM will convert text files to CARDEX data files,
  188. but should only be used with caution as incorrect string lengths, number and
  189. placement of data and carriage returns will result in corrupted CARDEX data
  190. files. the source text file and target CARDEX data file can be passed to
  191. TEXT2CX.COM as command line parameters.
  192.  
  193. Other external utilities are: CXMERGE.COM which merges, (in alphabetical order),
  194. two CARDEX data files, creating a single merged CARDEX data file. ZIPSORT.COM
  195. is a utility that filters a CARDEX data file to produce a subset data file that
  196. contain only a specific zip code. This is handy when you want to break up
  197. CARDEX data files into smaller geographically based files. IE: you can create a
  198. file that only contains customers in a specific zip code for selected mailings.
  199. The command line parameters for ZIPSORT.COM are the source CARDEX data file,
  200. and the zip code to filter for. The resulting target file has the zip code as
  201. the prefix, and ".ZIP" as the suffix. This target file is then used like any
  202. other CARDEX data file.
  203.  
  204.               --------------------------------------------------
  205.  
  206. Record format - The first field is the person's last name The second field is
  207. the person's first name. The third field is the telephone area code. A default
  208. will appear (which is set by the confirguration/set-up) and can selected by a
  209. carriage return, or changed by overwriting the area code. The forth field is
  210. the first 3 digits of the telephone number. ENTER A CARRIAGE RETURN AFTER ONLY
  211. 3 DIGITS AS THE LAST 4 DIGITS ARE ANOTHER DATA FIELD.The forth field is the
  212. first 3 digits of the phone number, the fifth field is the last 4 digits of
  213. the phone number. The above is all on the first line and appears on the 3 cards
  214. above and the 3 cards below the current card.
  215.  
  216. The second line contains the address field only. (sixth field)
  217.  
  218. The third line contains the city name (seventh field), the state code
  219. (2 letters only), (eighth field), then the 5 digit zip code, (ninth field) and
  220. finally, the last 4 digits of extended zip codes. (tenth field)
  221.  
  222. The next line on the card is blank (used for messages by the CARDEX program).
  223.  
  224. The last five lines of the card are each a single field per line, for entering
  225. free-form additional data. (fields 11 through 15)
  226.  
  227. Field lengths: 19,15,3,3,4,54,26,2,5,4,54,54,54,54,54
  228. (405 bytes data and 15 bytes record structure)
  229.  
  230. Data can be stored in less space externally as ASCII. (Trailing spaces are not
  231. written to text files using CX2TEXT.COM). So if disk space or file transmission
  232. speed are critical, convert CARDEX files to ASCII, then copy, transfer, etc.,
  233. then convert the ASCII file back to a CARDEX file using TEXT2CX.COM.
  234.  
  235.               --------------------------------------------------
  236.  
  237. Configuration file (CARDEX.CFG) - Is written to and read from CARDEX. It tells
  238. the program what type of monitor is in use,(Color, Monochrome-Graphics, or
  239. Monochrome-Text), the local area code of the user, (so the area code prefix is
  240. or not available to SIDEKICK (tm) by Borland Intl for telephone number dialing
  241. if the user is modem equiped, and lastly, the default data file is specified.
  242. This is the data file that appears in the opening screen as the default, which
  243. can be default selected with a carriage return in the opening screen.
  244. The configuration file is a 5 line text file. If this file is not present,
  245. CARDEX has internal defaults settings which are : Monochrome-Text, Area code
  246. 808, Long Distance Access "1-", No Form Feeds to the Printer, and default data
  247. file CARDEX.DAT. The configuration of CARDEX can be done "on the fly" while
  248. the program is operating and can also be done from the opening.
  249. The CONFIGURATION/SET-UP mode is entered by pressing the F1 function key.
  250.  
  251. If the cursor is not displayed during EDIT, ADD, etc., you probably have not
  252. configured CARDEX for your color monitor. Press F1 to enter the configure mode.
  253.  
  254.  
  255. -------------------------------------------------------------------------------
  256.  
  257.                              PARAMETER PASSING
  258.  
  259. CARDEX can optionally have a data file name passed to it upon call from DOS.
  260. This eliminates the opening screen from appearing with its data file prompt.
  261. The data file name is specified after "CARDEX" at the DOS prompt.
  262.    IE : A> CARDEX YOURFILE.DAT   (YOURFILE.DAT being the data file name)
  263.  
  264. You may also declare the default data file by passing "*" as the parameter.
  265.    IE : A> CARDEX *              (Selects the default data file)
  266.  
  267. To have CARDEX print this documentation file to the monitor, pass "?" as the
  268. file parameter. To send a make a hard copy of this documentation file, at the
  269. DOS prompt type Ctrl-P (depress the Ctrl and P keys together) to toggle on the
  270. printer, then enter "TYPE CARDEX.DOC" followed by a carriage return. Remember
  271. to toggle off your printer later by again typing Ctrl-P.
  272.    IE : A> CARDEX ?              (Displays this documentation file)
  273.  
  274. CARDEX can optionally have a second parameter passed to it. The second
  275. parameter is a "GOTO" entry for advancing to a particular CARD entry.
  276.    IE: A> CARDEX * CARSON   (Selects the default data file and advances to
  277.                              the CARD entry with last name of "CARSON")
  278.    IE: A> CARDEX CARDEX.DAT JONES/BILL
  279.                           (Selects data file "CARDEX.DAT" and advances to CARD
  280.                            entry with last name "JONES" and first name "BILL")
  281.  
  282. -------------------------------------------------------------------------------
  283.  
  284.                              DEVELOPMENT NOTES
  285.  
  286. CARDEX was written by Mark Carson in Hawaii as a personal productivity aid.
  287. It was started the 4th of July holiday weekend 1985.
  288. The development language was Borland International's TURBO Pascal version 3.0
  289. Some procedures used were written by Blaise Computing, (Cursor control).
  290.  
  291. -------------------------------------------------------------------------------